home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 2000 April: Mac OS SDK / Dev.CD Apr 00 SDK1.toast / Development Kits / Mac OS / Apple Guide / Engineering / APISample / APISampleCW / About APISampleCW next >
Encoding:
Text File  |  1994-12-05  |  1.9 KB  |  44 lines  |  [ttro/ttxt]
  1. About APISampleCW
  2. 22-Apr-94
  3.  
  4. APISampleCW is work-in-progress for a demonstration of Apple Guide integration.
  5.  
  6. --- Installation -------------
  7.  
  8. The following files are required:
  9.  
  10. APISampleCW - the application.
  11. Assistant - the Apple Guide file for APISampleCW. Place in the same folder as APISampleCW.
  12. System 7.5 - Apple Guide is included in the system release.
  13.  
  14. --- Operation ---------------
  15.  
  16. Double-click on APISampleCW.  Use the "APISampleCW" menu to open the default guide file (Assistant). The Assistant guide file will help you browse APISampleCW and demonstrate its features.
  17.  
  18. --- Apple Guide Support -------
  19.  
  20. APISampleCW uses the standard Apple Guide interface.  Current functionality includes the following:
  21.  
  22. • Sensing the current state of Apple Guide (installed, standby, running, etc.)
  23. • Detecting which "standard" help databases are available (Tutorial, Shortcuts, etc.)
  24. • Telling Apple Guide to startup with the default database or any specified database.
  25. • Responding to dynamic Coach-marking events.
  26. • Responding to context-check events.
  27. • Receiving events from Apple Guide.
  28. • Sending events to Apple Guide.
  29. • Finding Apple Guide databases, determining their type, and opening them.
  30.  
  31. --- Building APISampleCW ----------
  32.  
  33. The source code for APISampleCW is available on the "develop" Bookmark CD and on the Developer Reference Library CD.
  34.  
  35. TApplication and TDocument are built separately and are included as libraries in the build of APISampleCW.  They were copied without change from MPW CPlusExamples (ETO #8 or newer).  They should do not need rebuilding.
  36.  
  37. To build APISampleCW, set the directory path to the folder containing the APISampleCW files.  Then enter "BuildProgram APISampleCW". See APISampleCW.make for more information.
  38.  
  39. The Assistant database is already built for you. Source is provided, but you will need the Apple Guide authoring tool to compile it.
  40.  
  41. --- For more information --------------------
  42.  
  43. Please direct your questions and comments to "APPLE.GUIDE".
  44.